<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_frmbuf_rd: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_frmbuf_rd
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__frmbuf__rd.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga08b753ae28c0a8c47f3a57428c84390e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga08b753ae28c0a8c47f3a57428c84390e">XVFrmbufRd_HandlerType</a> { <a class="el" href="group__v__frmbuf__rd.html#gga08b753ae28c0a8c47f3a57428c84390ea3fded5e73774f181a0d9189a97f5c630">XVFRMBUFRD_HANDLER_DONE</a> = 1, 
<a class="el" href="group__v__frmbuf__rd.html#gga08b753ae28c0a8c47f3a57428c84390ea2576014c6c4d14a4364c9f90938c75a3">XVFRMBUFRD_HANDLER_READY</a>
 }</td></tr>
<tr class="memdesc:ga08b753ae28c0a8c47f3a57428c84390e"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify different types of handler and used to differentiate interrupt requests from peripheral.  <a href="group__v__frmbuf__rd.html#ga08b753ae28c0a8c47f3a57428c84390e">More...</a><br/></td></tr>
<tr class="separator:ga08b753ae28c0a8c47f3a57428c84390e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadae724d8b7d9c6738817c82912c45a3c"><td class="memItemLeft" align="right" valign="top">XVidC_ColorFormat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gadae724d8b7d9c6738817c82912c45a3c">RdMemory2Live</a> (XVidC_ColorFormat MemFmt)</td></tr>
<tr class="memdesc:gadae724d8b7d9c6738817c82912c45a3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function maps the memory video formats to the live/stream video formats.  <a href="#gadae724d8b7d9c6738817c82912c45a3c">More...</a><br/></td></tr>
<tr class="separator:gadae724d8b7d9c6738817c82912c45a3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed42e419ae477b01e8677cabe9d07edc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaed42e419ae477b01e8677cabe9d07edc">XVFrmbufRd_Initialize</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:gaed42e419ae477b01e8677cabe9d07edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the core instance.  <a href="#gaed42e419ae477b01e8677cabe9d07edc">More...</a><br/></td></tr>
<tr class="separator:gaed42e419ae477b01e8677cabe9d07edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95f8a0ce5448dc0b3adcaed0365aacfb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga95f8a0ce5448dc0b3adcaed0365aacfb">XVFrmbufRd_InterruptEnable</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 IrqMask)</td></tr>
<tr class="memdesc:ga95f8a0ce5448dc0b3adcaed0365aacfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables interrupts in the core.  <a href="#ga95f8a0ce5448dc0b3adcaed0365aacfb">More...</a><br/></td></tr>
<tr class="separator:ga95f8a0ce5448dc0b3adcaed0365aacfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0faa399949f921d9a32ceb8321de756e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga0faa399949f921d9a32ceb8321de756e">XVFrmbufRd_InterruptDisable</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 IrqMask)</td></tr>
<tr class="memdesc:ga0faa399949f921d9a32ceb8321de756e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables interrupts in the core.  <a href="#ga0faa399949f921d9a32ceb8321de756e">More...</a><br/></td></tr>
<tr class="separator:ga0faa399949f921d9a32ceb8321de756e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e9f4473b9679d84441160c08b461d9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga0e9f4473b9679d84441160c08b461d9b">XVFrmbufRd_Start</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga0e9f4473b9679d84441160c08b461d9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the core instance.  <a href="#ga0e9f4473b9679d84441160c08b461d9b">More...</a><br/></td></tr>
<tr class="separator:ga0e9f4473b9679d84441160c08b461d9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf95f5597208997861ca3b2de238821e1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaf95f5597208997861ca3b2de238821e1">XVFrmbufRd_Stop</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf95f5597208997861ca3b2de238821e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the core instance.  <a href="#gaf95f5597208997861ca3b2de238821e1">More...</a><br/></td></tr>
<tr class="separator:gaf95f5597208997861ca3b2de238821e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05848286286c2df893b2ef8195167e47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga05848286286c2df893b2ef8195167e47">XVFrmbufRd_WaitForIdle</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga05848286286c2df893b2ef8195167e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Waits for the core to reach idle state.  <a href="#ga05848286286c2df893b2ef8195167e47">More...</a><br/></td></tr>
<tr class="separator:ga05848286286c2df893b2ef8195167e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d3a4c93e59a529e936c21169f738202"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga8d3a4c93e59a529e936c21169f738202">XVFrmbufRd_SetMemFormat</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 StrideInBytes, XVidC_ColorFormat MemFmt, const XVidC_VideoStream *StrmOut)</td></tr>
<tr class="memdesc:ga8d3a4c93e59a529e936c21169f738202"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the frame buffer read memory input.  <a href="#ga8d3a4c93e59a529e936c21169f738202">More...</a><br/></td></tr>
<tr class="separator:ga8d3a4c93e59a529e936c21169f738202"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafa85f47f05af0d3353f3cdcadbb29a1c"><td class="memItemLeft" align="right" valign="top">XVidC_VideoStream *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gafa85f47f05af0d3353f3cdcadbb29a1c">XVFrmbufRd_GetVideoStream</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gafa85f47f05af0d3353f3cdcadbb29a1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the pointer to the output stream configuration.  <a href="#gafa85f47f05af0d3353f3cdcadbb29a1c">More...</a><br/></td></tr>
<tr class="separator:gafa85f47f05af0d3353f3cdcadbb29a1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab166d212d55646b832a8f7c301e5f2ac"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gab166d212d55646b832a8f7c301e5f2ac">XVFrmbufRd_SetBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:gab166d212d55646b832a8f7c301e5f2ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address.  <a href="#gab166d212d55646b832a8f7c301e5f2ac">More...</a><br/></td></tr>
<tr class="separator:gab166d212d55646b832a8f7c301e5f2ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeac91da19a88ff2480eae16be554b1f2"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaeac91da19a88ff2480eae16be554b1f2">XVFrmbufRd_GetBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaeac91da19a88ff2480eae16be554b1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address.  <a href="#gaeac91da19a88ff2480eae16be554b1f2">More...</a><br/></td></tr>
<tr class="separator:gaeac91da19a88ff2480eae16be554b1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga84c9a6e2049cb53358884cd8e3aafbc2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga84c9a6e2049cb53358884cd8e3aafbc2">XVFrmbufRd_SetVChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:ga84c9a6e2049cb53358884cd8e3aafbc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address for the V plane for 3 planar formats.  <a href="#ga84c9a6e2049cb53358884cd8e3aafbc2">More...</a><br/></td></tr>
<tr class="separator:ga84c9a6e2049cb53358884cd8e3aafbc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacca36af12be280cd3cc168feb0a28bd4"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gacca36af12be280cd3cc168feb0a28bd4">XVFrmbufRd_GetVChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gacca36af12be280cd3cc168feb0a28bd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address for the V plane for 3 planar formats.  <a href="#gacca36af12be280cd3cc168feb0a28bd4">More...</a><br/></td></tr>
<tr class="separator:gacca36af12be280cd3cc168feb0a28bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga395f9c364ef8378189bf0464d2130d59"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga395f9c364ef8378189bf0464d2130d59">XVFrmbufRd_SetChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:ga395f9c364ef8378189bf0464d2130d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address for the UV plane for semi-planar formats or Only U Plane for 3 planar formats.  <a href="#ga395f9c364ef8378189bf0464d2130d59">More...</a><br/></td></tr>
<tr class="separator:ga395f9c364ef8378189bf0464d2130d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7475f43a7f18a159c1714849fe170c3b"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga7475f43a7f18a159c1714849fe170c3b">XVFrmbufRd_GetChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7475f43a7f18a159c1714849fe170c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address for the UV plane for semi-planar formats or Only U plane for 3 planar formats.  <a href="#ga7475f43a7f18a159c1714849fe170c3b">More...</a><br/></td></tr>
<tr class="separator:ga7475f43a7f18a159c1714849fe170c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76d715c4caace0c73116230fb3b51a66"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga76d715c4caace0c73116230fb3b51a66">XVFrmbufRd_SetFieldID</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 FieldID)</td></tr>
<tr class="memdesc:ga76d715c4caace0c73116230fb3b51a66"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the field ID.  <a href="#ga76d715c4caace0c73116230fb3b51a66">More...</a><br/></td></tr>
<tr class="separator:ga76d715c4caace0c73116230fb3b51a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf6aab33970a5d93caf764bddea2c86c4"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaf6aab33970a5d93caf764bddea2c86c4">XVFrmbufRd_GetFieldID</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf6aab33970a5d93caf764bddea2c86c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the field ID.  <a href="#gaf6aab33970a5d93caf764bddea2c86c4">More...</a><br/></td></tr>
<tr class="separator:gaf6aab33970a5d93caf764bddea2c86c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b93653c8567e7735888fe5e8c76aabf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga2b93653c8567e7735888fe5e8c76aabf">XVFrmbufRd_Set_FidOutMode</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 fidmodeval)</td></tr>
<tr class="memdesc:ga2b93653c8567e7735888fe5e8c76aabf"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the Fidout Mode Value.  <a href="#ga2b93653c8567e7735888fe5e8c76aabf">More...</a><br/></td></tr>
<tr class="separator:ga2b93653c8567e7735888fe5e8c76aabf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga332ca9116cadeb32b1904ce3dde65abc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga332ca9116cadeb32b1904ce3dde65abc">XVFrmbufRd_Get_FidOutMode</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga332ca9116cadeb32b1904ce3dde65abc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the Fidout Mode Value.  <a href="#ga332ca9116cadeb32b1904ce3dde65abc">More...</a><br/></td></tr>
<tr class="separator:ga332ca9116cadeb32b1904ce3dde65abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7f04dec0da407195c91e99252ba2f4d"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaa7f04dec0da407195c91e99252ba2f4d">XVFrmbufRd_Get_FidErrorOut</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaa7f04dec0da407195c91e99252ba2f4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the Fid error Register and extract error flag.  <a href="#gaa7f04dec0da407195c91e99252ba2f4d">More...</a><br/></td></tr>
<tr class="separator:gaa7f04dec0da407195c91e99252ba2f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a2a50eb3122b05363529db59acaa699"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga4a2a50eb3122b05363529db59acaa699">XVFrmbufRd_Get_FidErrorCount</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga4a2a50eb3122b05363529db59acaa699"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the Fid error Register and extract error count.  <a href="#ga4a2a50eb3122b05363529db59acaa699">More...</a><br/></td></tr>
<tr class="separator:ga4a2a50eb3122b05363529db59acaa699"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa3a66d4846e2dc24fef32aa98ac9806c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gaa3a66d4846e2dc24fef32aa98ac9806c">XVFrmbufRd_Get_FieldOut</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaa3a66d4846e2dc24fef32aa98ac9806c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the field Out.  <a href="#gaa3a66d4846e2dc24fef32aa98ac9806c">More...</a><br/></td></tr>
<tr class="separator:gaa3a66d4846e2dc24fef32aa98ac9806c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga80af786a199e9d406016cbe77c6cce9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga80af786a199e9d406016cbe77c6cce9a">XVFrmbufRd_DbgReportStatus</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga80af786a199e9d406016cbe77c6cce9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports the frame buffer read status.  <a href="#ga80af786a199e9d406016cbe77c6cce9a">More...</a><br/></td></tr>
<tr class="separator:ga80af786a199e9d406016cbe77c6cce9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga90785baf366d034a2e602ec6cd5a9dff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff">XVFrmbufRd_SetCallback</a> (<a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:ga90785baf366d034a2e602ec6cd5a9dff"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="#ga90785baf366d034a2e602ec6cd5a9dff">More...</a><br/></td></tr>
<tr class="separator:ga90785baf366d034a2e602ec6cd5a9dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2c3dd4bfc1f4acf08353543704c836b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gab2c3dd4bfc1f4acf08353543704c836b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the frame buffer read core driver.  <a href="#gab2c3dd4bfc1f4acf08353543704c836b">More...</a><br/></td></tr>
<tr class="separator:gab2c3dd4bfc1f4acf08353543704c836b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga08b753ae28c0a8c47f3a57428c84390e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__frmbuf__rd.html#ga08b753ae28c0a8c47f3a57428c84390e">XVFrmbufRd_HandlerType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify different types of handler and used to differentiate interrupt requests from peripheral. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga08b753ae28c0a8c47f3a57428c84390ea3fded5e73774f181a0d9189a97f5c630"></a>XVFRMBUFRD_HANDLER_DONE</em>&nbsp;</td><td class="fielddoc">
<p>Handler for ap_done. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga08b753ae28c0a8c47f3a57428c84390ea2576014c6c4d14a4364c9f90938c75a3"></a>XVFRMBUFRD_HANDLER_READY</em>&nbsp;</td><td class="fielddoc">
<p>Handler for ap_ready. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gadae724d8b7d9c6738817c82912c45a3c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_ColorFormat RdMemory2Live </td>
          <td>(</td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>MemFmt</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function maps the memory video formats to the live/stream video formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MemFmt</td><td>is the video format read from memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Live/Stream Video Format associated with that memory format </dd></dl>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#ga8d3a4c93e59a529e936c21169f738202">XVFrmbufRd_SetMemFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga80af786a199e9d406016cbe77c6cce9a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufRd_DbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports the frame buffer read status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd___config.html#a5c264b3bca3a8e49ab5a5fa549e63a22">XV_frmbufrd_Config::AXIMMDataWidth</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a6229f3b0866dac75bd3f425693f886f4">XV_frmbufrd_Config::BaseAddress</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#af2eab7310b1ab55f84a5ae48a4b7a1c6">XV_frmbufrd_Config::BGR8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a42c8816efe3e98b5e8e328dc84cf0e69">XV_frmbufrd_Config::BGRA8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a9e80ff6372f31d24faa6ebbf80882f0a">XV_frmbufrd_Config::BGRX8En</a>, <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#afa30637712f26c12cff03ca7442e7b03">XV_frmbufrd_Config::IsTileFormat</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a92843183639024e2d4aa70796c50c594">XV_frmbufrd_Config::MaxDataWidth</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#acf9e48679e5b62a96773b6e31a06d8db">XV_frmbufrd_Config::PixPerClk</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a8eafbda34c7dcfe8e88e63f7eadff463">XV_frmbufrd_Config::RGB16En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a35b47e21bc2c6a0a0c38adb00f8dbc69">XV_frmbufrd_Config::RGB8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a491416764de129e257f43cc412098c8c">XV_frmbufrd_Config::RGBA8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#ae18753e8f48581e9f2c07f3316563ae4">XV_frmbufrd_Config::RGBX10En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a33a6f42b78f723e65a6d11010c7d1ddf">XV_frmbufrd_Config::RGBX12En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#ae4d0984d4f7ed39d870cb86ecb323db0">XV_frmbufrd_Config::RGBX8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a686a45377a379aab5d7ac54cdbe7199e">XV_frmbufrd_Config::UYVY8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#ae9843a8e3b3cc67104faaee20b511cf6">XV_frmbufrd_Config::Y10En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a33a690d459578c94feca9a088f5d24e4">XV_frmbufrd_Config::Y12En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a0289c00ae14478df4c4c6c934d48d71d">XV_frmbufrd_Config::Y16En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a2be774ba1b959b5db938eb11c82088e5">XV_frmbufrd_Config::Y8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a146d3832ce11d45ad055eb4e4bbea721">XV_frmbufrd_Config::Y_U_V10En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a169498c5eb2717170ce05a3f9c452eb3">XV_frmbufrd_Config::Y_U_V12En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#af6bb10d500393cb3e58a776de88ccd6a">XV_frmbufrd_Config::Y_U_V8_420En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#ac5e83943b8d5ce0a4a9cfd94ce826603">XV_frmbufrd_Config::Y_U_V8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a237956ff2d7b7e3ba9446191a814a0ef">XV_frmbufrd_Config::Y_UV10_420En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a91ab6c96db15ae2bea46023087a80a72">XV_frmbufrd_Config::Y_UV10En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a4b91ff5115bff40354e38275d7002773">XV_frmbufrd_Config::Y_UV12_420En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a4feee426739cfb05746c1f3b4fb77bc6">XV_frmbufrd_Config::Y_UV12En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#acc32458a9c17c64e4ba34be13cf3450a">XV_frmbufrd_Config::Y_UV16_420En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#af195e57736581b63559a880288b657a0">XV_frmbufrd_Config::Y_UV16En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a30b0293bfdd550b1757f979f0e7d9517">XV_frmbufrd_Config::Y_UV8_420En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#aed1ba306c17bddb97b1005b2ba2de954">XV_frmbufrd_Config::Y_UV8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a63d2add0f85a03b20b9821f5185c5e8a">XV_frmbufrd_Config::YUV16En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a0f08d1a6abb209e54847fd78ed574cac">XV_frmbufrd_Config::YUV8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a820a4f365717f19484c2152ab2f3aca0">XV_frmbufrd_Config::YUVA8En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a61ee96917cf6c65ae74d42b0d12e19b2">XV_frmbufrd_Config::YUVX10En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a22bac40a0615a432160e2babe681df50">XV_frmbufrd_Config::YUVX12En</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#a16b91c3aa0927a744150eb3450ff8557">XV_frmbufrd_Config::YUVX8En</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#a97ce077fe3e21e5779e1c00e623d7c41">XV_frmbufrd_Config::YUYV8En</a>.</p>

</div>
</div>
<a class="anchor" id="ga4a2a50eb3122b05363529db59acaa699"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufRd_Get_FidErrorCount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the Fid error Register and extract error count. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Fid Error count </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gaa7f04dec0da407195c91e99252ba2f4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufRd_Get_FidErrorOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the Fid error Register and extract error flag. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Fid Error flag </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="ga332ca9116cadeb32b1904ce3dde65abc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufRd_Get_FidOutMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the Fidout Mode Value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Fidout Mode Value </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gaa3a66d4846e2dc24fef32aa98ac9806c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufRd_Get_FieldOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the field Out. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Field Out </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gaeac91da19a88ff2480eae16be554b1f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufRd_GetBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="ga7475f43a7f18a159c1714849fe170c3b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufRd_GetChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address for the UV plane for semi-planar formats or Only U plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="gaf6aab33970a5d93caf764bddea2c86c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufRd_GetFieldID </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the field ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Field ID </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gacca36af12be280cd3cc168feb0a28bd4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufRd_GetVChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address for the V plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="gafa85f47f05af0d3353f3cdcadbb29a1c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_VideoStream* XVFrmbufRd_GetVideoStream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the pointer to the output stream configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to output stream configuration </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#ada8c009caccb985b0e3410c572852b73">XV_FrmbufRd_l2::Stream</a>.</p>

</div>
</div>
<a class="anchor" id="gaed42e419ae477b01e8677cabe9d07edc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is instance id of the core</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="ga0faa399949f921d9a32ceb8321de756e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufRd_InterruptDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IrqMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function disables interrupts in the core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="ga95f8a0ce5448dc0b3adcaed0365aacfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufRd_InterruptEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IrqMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables interrupts in the core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="gab2c3dd4bfc1f4acf08353543704c836b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufRd_InterruptHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the frame buffer read core driver. </p>
<p>This handler clears the pending interrupt and determined if the source is frame done signal. If yes, starts the next frame processing and calls the registered callback function</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff" title="This function installs an asynchronous callback function for the given HandlerType: ...">XVFrmbufRd_SetCallback()</a> during initialization phase.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#af5197034b172783210b2cb88547bfa87">XV_FrmbufRd_l2::CallbackDoneRef</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#aff68a0427bdc269ca05fde57f7cc8743">XV_FrmbufRd_l2::CallbackReadyRef</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a89bc60bff119d8099d26f5e5fa6bebfa">XV_FrmbufRd_l2::FrameDoneCallback</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a48f7a71fe84c44380cc6c1d253e0fa67">XV_FrmbufRd_l2::FrameReadyCallback</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd.html#a4eaed8d81587971809682b514a80455a">XV_frmbufrd::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga2b93653c8567e7735888fe5e8c76aabf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_Set_FidOutMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>fidmodeval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the Fidout Mode Value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">fidmodeval</td><td>is a value to be written</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gab166d212d55646b832a8f7c301e5f2ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#acf9e48679e5b62a96773b6e31a06d8db">XV_frmbufrd_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="ga90785baf366d034a2e602ec6cd5a9dff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                     Callback Function Type
</p>
<hr/>
<p>
(XVFRMBUFRD_HANDLER_DONE)       DoneCallback
(XVFRMBUFRD_HANDLER_READY)      ReadyCallback</pre><pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Frame Buffer Read core instance.
</td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address of the callback function.
</td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a user data item that will be passed to the
          callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if callback function installed successfully.</li>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been
        installed replaces it with the new handler.
</dd></dl>
</pre>
<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#af5197034b172783210b2cb88547bfa87">XV_FrmbufRd_l2::CallbackDoneRef</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#aff68a0427bdc269ca05fde57f7cc8743">XV_FrmbufRd_l2::CallbackReadyRef</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a89bc60bff119d8099d26f5e5fa6bebfa">XV_FrmbufRd_l2::FrameDoneCallback</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a48f7a71fe84c44380cc6c1d253e0fa67">XV_FrmbufRd_l2::FrameReadyCallback</a>, <a class="el" href="group__v__frmbuf__rd.html#gga08b753ae28c0a8c47f3a57428c84390ea3fded5e73774f181a0d9189a97f5c630">XVFRMBUFRD_HANDLER_DONE</a>, and <a class="el" href="group__v__frmbuf__rd.html#gga08b753ae28c0a8c47f3a57428c84390ea2576014c6c4d14a4364c9f90938c75a3">XVFRMBUFRD_HANDLER_READY</a>.</p>

</div>
</div>
<a class="anchor" id="ga395f9c364ef8378189bf0464d2130d59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address for the UV plane for semi-planar formats or Only U Plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#acf9e48679e5b62a96773b6e31a06d8db">XV_frmbufrd_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="ga76d715c4caace0c73116230fb3b51a66"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetFieldID </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FieldID</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the field ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Field</td><td>ID</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#af39acffd50212a191944b93b31f6f6a7">XV_frmbufrd_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="ga8d3a4c93e59a529e936c21169f738202"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetMemFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>StrideInBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>MemFmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StrmOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the frame buffer read memory input. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">StrideInBytes</td><td>is the memory stride in bytes </td></tr>
    <tr><td class="paramname">MemFormat</td><td>is the video format to be read from memory </td></tr>
    <tr><td class="paramname">StrmOut</td><td>is the pointer to output stream configuration</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, <a class="el" href="struct_x_v__frmbufrd___config.html#acf9e48679e5b62a96773b6e31a06d8db">XV_frmbufrd_Config::PixPerClk</a>, <a class="el" href="group__v__frmbuf__rd.html#gadae724d8b7d9c6738817c82912c45a3c">RdMemory2Live()</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#ada8c009caccb985b0e3410c572852b73">XV_FrmbufRd_l2::Stream</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a8374d2a52b55cd1d0d883c1715beeb95">XVFrmbufRd_IsBGR8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a2c2bebae6f7834405800452a2718b08e">XVFrmbufRd_IsBGRA8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ad50076dd94381ee2f9c61b1a352f50e3">XVFrmbufRd_IsBGRX8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ad68e98d59c3e28afa9798eecd0cb9395">XVFrmbufRd_IsRGB16Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#abc7912a72ad9069eaa2c8c256227f48d">XVFrmbufRd_IsRGB8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ac5d79c8d6a806d8c60ab88c791701b51">XVFrmbufRd_IsRGBA8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ae8683607b1d600806035f9ef05a91f2c">XVFrmbufRd_IsRGBX10Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#adbb83a2783746f4ae14b3a027c28d324">XVFrmbufRd_IsRGBX12Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#afb80fe345462edfe56db7d6c2c813029">XVFrmbufRd_IsRGBX8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a1af870973f8df08f89bb851afdf0c1e7">XVFrmbufRd_IsUYVY8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a5c0ebf78eace360414715ab292640627">XVFrmbufRd_IsY10Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#acc6eed954bd90827724e5e0d04c4afe4">XVFrmbufRd_IsY12Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a165226e3e6012ee39de4e546912aa746">XVFrmbufRd_IsY16Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a7f2ef61429f951abf67553c2c95f07d3">XVFrmbufRd_IsY8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#aa20c2caa52e7a1b51ce9853529b7cfe2">XVFrmbufRd_IsY_U_V10Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ae6ab1c3eb16a033d601d7c317135f95a">XVFrmbufRd_IsY_U_V12Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#aab82c3cfb54edd87afe6e3f5dcee4843">XVFrmbufRd_IsY_U_V8_420Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a830017855588757aa80927de374eca11">XVFrmbufRd_IsY_U_V8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a55124ca10ab9195da4de482995457192">XVFrmbufRd_IsY_UV10_420Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a030eebfec7b471edeb9755266947fe4d">XVFrmbufRd_IsY_UV10Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#abb6d7e70c89eec7c9c371fcf2b6a37d5">XVFrmbufRd_IsY_UV12_420Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#ac504b9cc6a13cc1600bdfd9f8ad349ba">XVFrmbufRd_IsY_UV12Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a1c29cb4f9658c846c6bf7fdda191dfa8">XVFrmbufRd_IsY_UV16_420Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#af5535c6e8ab25968a1a79e3d56f0e02a">XVFrmbufRd_IsY_UV16Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#af0cefbd264457a557168b17addba390d">XVFrmbufRd_IsY_UV8_420Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#aed865a631e64e4cc89eb450aebceded7">XVFrmbufRd_IsY_UV8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a58ff3cf4e82d19e8e2d43531cf76fa04">XVFrmbufRd_IsYUV16Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a74c5c26e350751452b4235baf9fbe39d">XVFrmbufRd_IsYUV8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#acd3e8dd739743f9aa9fd2b20b9338036">XVFrmbufRd_IsYUVA8Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#af92d92dd3a05e355415f6870e393535b">XVFrmbufRd_IsYUVX10Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a47c790924841c197ce6b6e8577318b6c">XVFrmbufRd_IsYUVX12Enabled</a>, <a class="el" href="xv__frmbufrd__l2_8h.html#a52b216d384a061ba296a2534e3e1539b">XVFrmbufRd_IsYUVX8Enabled</a>, and <a class="el" href="xv__frmbufrd__l2_8h.html#adb8283b37d9794b80e2a831b427ae3ff">XVFrmbufRd_IsYUYV8Enabled</a>.</p>

</div>
</div>
<a class="anchor" id="ga84c9a6e2049cb53358884cd8e3aafbc2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_SetVChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address for the V plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufrd.html#a41c39d1f57583f4ca8eb0f7bbc9c29fe">XV_frmbufrd::Config</a>, <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>, and <a class="el" href="struct_x_v__frmbufrd___config.html#acf9e48679e5b62a96773b6e31a06d8db">XV_frmbufrd_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="ga0e9f4473b9679d84441160c08b461d9b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufRd_Start </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function starts the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="gaf95f5597208997861ca3b2de238821e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_Stop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if the core in stop state XST_FAILURE if the core is not in stop state </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
<a class="anchor" id="ga05848286286c2df893b2ef8195167e47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufRd_WaitForIdle </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_rd__l2.html">XV_FrmbufRd_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Waits for the core to reach idle state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if the core is in idle state XST_FAILURE if the core is not in idle state </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">XV_FrmbufRd_l2::FrmbufRd</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
